Restore autodocs cut-lines with empty what-hints #13013
Closed
+1
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
During typecheck improvements [1], the change accidentally removed the ability for autodoc's `cut_lines` call to run when no what-hints are provided. The `what` argument may be empty and an empty scenario should not stop the cut call from processing lines. [1]: sphinx-doc#12933 Signed-off-by: James Knight <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
During typecheck improvements, a change accidentally removed the ability for autodoc's
cut_linescall to run when no what-hints are provided. Thewhatargument may be empty and an empty scenario should not stop the cut call from processing lines.Example
An example documentation set configures
cut_lineswhich has a rendering that excludes the leading line of the docstrings. However, a render (at the time of writing) using Sphinx 8.1.2 show docstrings not being cut.Relates
docs/conf.py(#12697)" #12933